<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Agile Modbus: agile_modbus Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Agile Modbus
   &#160;<span id="projectnumber">1.1.4</span>
   </div>
   <div id="projectbrief">Lightweight modbus protocol stack.</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('structagile__modbus.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-attribs">Data Fields</a>  </div>
  <div class="headertitle">
<div class="title">agile_modbus Struct Reference<div class="ingroups"><a class="el" href="group___c_o_m_m_o_n.html">Common</a> &raquo; <a class="el" href="group___c_o_m_m_o_n___exported___types.html">Common Exported Types</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p>Agile Modbus structure.  
 <a href="structagile__modbus.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="agile__modbus_8h_source.html">agile_modbus.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for agile_modbus:</div>
<div class="dyncontent">
<div class="center"><img src="structagile__modbus__coll__graph.png" border="0" usemap="#aagile__modbus_coll__map" alt="Collaboration graph"/></div>
<map name="aagile__modbus_coll__map" id="aagile__modbus_coll__map">
<area shape="rect" title="Agile Modbus structure." alt="" coords="36,95,149,121"/>
<area shape="rect" href="structagile__modbus__backend.html" title="Agile Modbus backend interface structure." alt="" coords="5,5,180,32"/>
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:acd02aacf2081b397ee378e21858b2dd7"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structagile__modbus.html#acd02aacf2081b397ee378e21858b2dd7">slave</a></td></tr>
<tr class="memdesc:acd02aacf2081b397ee378e21858b2dd7"><td class="mdescLeft">&#160;</td><td class="mdescRight">slave address  <a href="structagile__modbus.html#acd02aacf2081b397ee378e21858b2dd7">More...</a><br /></td></tr>
<tr class="separator:acd02aacf2081b397ee378e21858b2dd7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7ab3e38c7f75daba9d3ea33ddc41d69e"><td class="memItemLeft" align="right" valign="top">uint8_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structagile__modbus.html#a7ab3e38c7f75daba9d3ea33ddc41d69e">send_buf</a></td></tr>
<tr class="memdesc:a7ab3e38c7f75daba9d3ea33ddc41d69e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send buffer.  <a href="structagile__modbus.html#a7ab3e38c7f75daba9d3ea33ddc41d69e">More...</a><br /></td></tr>
<tr class="separator:a7ab3e38c7f75daba9d3ea33ddc41d69e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5ca6f195fce50ce2152bef4f54fc4c8a"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structagile__modbus.html#a5ca6f195fce50ce2152bef4f54fc4c8a">send_bufsz</a></td></tr>
<tr class="memdesc:a5ca6f195fce50ce2152bef4f54fc4c8a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send buffer size.  <a href="structagile__modbus.html#a5ca6f195fce50ce2152bef4f54fc4c8a">More...</a><br /></td></tr>
<tr class="separator:a5ca6f195fce50ce2152bef4f54fc4c8a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7ae0e70e10647b910250928d8b15bc17"><td class="memItemLeft" align="right" valign="top">uint8_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structagile__modbus.html#a7ae0e70e10647b910250928d8b15bc17">read_buf</a></td></tr>
<tr class="memdesc:a7ae0e70e10647b910250928d8b15bc17"><td class="mdescLeft">&#160;</td><td class="mdescRight">Receive buffer.  <a href="structagile__modbus.html#a7ae0e70e10647b910250928d8b15bc17">More...</a><br /></td></tr>
<tr class="separator:a7ae0e70e10647b910250928d8b15bc17"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad3d742a082530ee2dc6b55c04d80d9a2"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structagile__modbus.html#ad3d742a082530ee2dc6b55c04d80d9a2">read_bufsz</a></td></tr>
<tr class="memdesc:ad3d742a082530ee2dc6b55c04d80d9a2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Receive buffer size.  <a href="structagile__modbus.html#ad3d742a082530ee2dc6b55c04d80d9a2">More...</a><br /></td></tr>
<tr class="separator:ad3d742a082530ee2dc6b55c04d80d9a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a374a8fa6bbae7c8c7c26fa0327d86c28"><td class="memItemLeft" align="right" valign="top">uint8_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structagile__modbus.html#a374a8fa6bbae7c8c7c26fa0327d86c28">compute_meta_length_after_function</a> )(<a class="el" href="group___c_o_m_m_o_n___exported___types.html#gad07c76f52ecac865589bdea79112ccb6">agile_modbus_t</a> *ctx, int function, <a class="el" href="group___c_o_m_m_o_n___exported___types.html#gaed0f4c33339c8ae9c8730abef9e0f02f">agile_modbus_msg_type_t</a> msg_type)</td></tr>
<tr class="memdesc:a374a8fa6bbae7c8c7c26fa0327d86c28"><td class="mdescLeft">&#160;</td><td class="mdescRight">Customized calculation data element length interface.  <a href="structagile__modbus.html#a374a8fa6bbae7c8c7c26fa0327d86c28">More...</a><br /></td></tr>
<tr class="separator:a374a8fa6bbae7c8c7c26fa0327d86c28"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a01a1cc40593d0b2f35c4bd9264024023"><td class="memItemLeft" align="right" valign="top">int(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structagile__modbus.html#a01a1cc40593d0b2f35c4bd9264024023">compute_data_length_after_meta</a> )(<a class="el" href="group___c_o_m_m_o_n___exported___types.html#gad07c76f52ecac865589bdea79112ccb6">agile_modbus_t</a> *ctx, uint8_t *msg, int msg_length, <a class="el" href="group___c_o_m_m_o_n___exported___types.html#gaed0f4c33339c8ae9c8730abef9e0f02f">agile_modbus_msg_type_t</a> msg_type)</td></tr>
<tr class="memdesc:a01a1cc40593d0b2f35c4bd9264024023"><td class="mdescLeft">&#160;</td><td class="mdescRight">Customized calculation data length interface.  <a href="structagile__modbus.html#a01a1cc40593d0b2f35c4bd9264024023">More...</a><br /></td></tr>
<tr class="separator:a01a1cc40593d0b2f35c4bd9264024023"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa9d48739d05877966b473beeb61176b7"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="group___c_o_m_m_o_n___exported___types.html#ga3de0b082d8d88e159d162bcf78ef123c">agile_modbus_backend_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structagile__modbus.html#aa9d48739d05877966b473beeb61176b7">backend</a></td></tr>
<tr class="memdesc:aa9d48739d05877966b473beeb61176b7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Backend interface.  <a href="structagile__modbus.html#aa9d48739d05877966b473beeb61176b7">More...</a><br /></td></tr>
<tr class="separator:aa9d48739d05877966b473beeb61176b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae1ab077d16f51a6dbaaa5e3136cf6053"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structagile__modbus.html#ae1ab077d16f51a6dbaaa5e3136cf6053">backend_data</a></td></tr>
<tr class="memdesc:ae1ab077d16f51a6dbaaa5e3136cf6053"><td class="mdescLeft">&#160;</td><td class="mdescRight">Backend data, pointing to RTU or TCP structure.  <a href="structagile__modbus.html#ae1ab077d16f51a6dbaaa5e3136cf6053">More...</a><br /></td></tr>
<tr class="separator:ae1ab077d16f51a6dbaaa5e3136cf6053"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Agile Modbus structure. </p>

<p class="definition">Definition at line <a class="el" href="agile__modbus_8h_source.html#l00217">217</a> of file <a class="el" href="agile__modbus_8h_source.html">agile_modbus.h</a>.</p>
</div><h2 class="groupheader">Field Documentation</h2>
<a id="acd02aacf2081b397ee378e21858b2dd7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acd02aacf2081b397ee378e21858b2dd7">&#9670;&nbsp;</a></span>slave</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int agile_modbus::slave</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>slave address </p>

<p class="definition">Definition at line <a class="el" href="agile__modbus_8h_source.html#l00218">218</a> of file <a class="el" href="agile__modbus_8h_source.html">agile_modbus.h</a>.</p>

</div>
</div>
<a id="a7ab3e38c7f75daba9d3ea33ddc41d69e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7ab3e38c7f75daba9d3ea33ddc41d69e">&#9670;&nbsp;</a></span>send_buf</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint8_t* agile_modbus::send_buf</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Send buffer. </p>

<p class="definition">Definition at line <a class="el" href="agile__modbus_8h_source.html#l00219">219</a> of file <a class="el" href="agile__modbus_8h_source.html">agile_modbus.h</a>.</p>

</div>
</div>
<a id="a5ca6f195fce50ce2152bef4f54fc4c8a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5ca6f195fce50ce2152bef4f54fc4c8a">&#9670;&nbsp;</a></span>send_bufsz</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int agile_modbus::send_bufsz</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Send buffer size. </p>

<p class="definition">Definition at line <a class="el" href="agile__modbus_8h_source.html#l00220">220</a> of file <a class="el" href="agile__modbus_8h_source.html">agile_modbus.h</a>.</p>

</div>
</div>
<a id="a7ae0e70e10647b910250928d8b15bc17"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7ae0e70e10647b910250928d8b15bc17">&#9670;&nbsp;</a></span>read_buf</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint8_t* agile_modbus::read_buf</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Receive buffer. </p>

<p class="definition">Definition at line <a class="el" href="agile__modbus_8h_source.html#l00221">221</a> of file <a class="el" href="agile__modbus_8h_source.html">agile_modbus.h</a>.</p>

</div>
</div>
<a id="ad3d742a082530ee2dc6b55c04d80d9a2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad3d742a082530ee2dc6b55c04d80d9a2">&#9670;&nbsp;</a></span>read_bufsz</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int agile_modbus::read_bufsz</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Receive buffer size. </p>

<p class="definition">Definition at line <a class="el" href="agile__modbus_8h_source.html#l00222">222</a> of file <a class="el" href="agile__modbus_8h_source.html">agile_modbus.h</a>.</p>

</div>
</div>
<a id="a374a8fa6bbae7c8c7c26fa0327d86c28"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a374a8fa6bbae7c8c7c26fa0327d86c28">&#9670;&nbsp;</a></span>compute_meta_length_after_function</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint8_t(* agile_modbus::compute_meta_length_after_function) (<a class="el" href="group___c_o_m_m_o_n___exported___types.html#gad07c76f52ecac865589bdea79112ccb6">agile_modbus_t</a> *ctx, int function, <a class="el" href="group___c_o_m_m_o_n___exported___types.html#gaed0f4c33339c8ae9c8730abef9e0f02f">agile_modbus_msg_type_t</a> msg_type)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Customized calculation data element length interface. </p>

<p class="definition">Definition at line <a class="el" href="agile__modbus_8h_source.html#l00223">223</a> of file <a class="el" href="agile__modbus_8h_source.html">agile_modbus.h</a>.</p>

</div>
</div>
<a id="a01a1cc40593d0b2f35c4bd9264024023"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a01a1cc40593d0b2f35c4bd9264024023">&#9670;&nbsp;</a></span>compute_data_length_after_meta</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int(* agile_modbus::compute_data_length_after_meta) (<a class="el" href="group___c_o_m_m_o_n___exported___types.html#gad07c76f52ecac865589bdea79112ccb6">agile_modbus_t</a> *ctx, uint8_t *msg, int msg_length, <a class="el" href="group___c_o_m_m_o_n___exported___types.html#gaed0f4c33339c8ae9c8730abef9e0f02f">agile_modbus_msg_type_t</a> msg_type)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Customized calculation data length interface. </p>

<p class="definition">Definition at line <a class="el" href="agile__modbus_8h_source.html#l00225">225</a> of file <a class="el" href="agile__modbus_8h_source.html">agile_modbus.h</a>.</p>

</div>
</div>
<a id="aa9d48739d05877966b473beeb61176b7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa9d48739d05877966b473beeb61176b7">&#9670;&nbsp;</a></span>backend</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const <a class="el" href="group___c_o_m_m_o_n___exported___types.html#ga3de0b082d8d88e159d162bcf78ef123c">agile_modbus_backend_t</a>* agile_modbus::backend</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Backend interface. </p>

<p class="definition">Definition at line <a class="el" href="agile__modbus_8h_source.html#l00227">227</a> of file <a class="el" href="agile__modbus_8h_source.html">agile_modbus.h</a>.</p>

</div>
</div>
<a id="ae1ab077d16f51a6dbaaa5e3136cf6053"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae1ab077d16f51a6dbaaa5e3136cf6053">&#9670;&nbsp;</a></span>backend_data</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void* agile_modbus::backend_data</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Backend data, pointing to RTU or TCP structure. </p>

<p class="definition">Definition at line <a class="el" href="agile__modbus_8h_source.html#l00228">228</a> of file <a class="el" href="agile__modbus_8h_source.html">agile_modbus.h</a>.</p>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>/home/runner/work/agile_modbus/agile_modbus/inc/<a class="el" href="agile__modbus_8h_source.html">agile_modbus.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="structagile__modbus.html">agile_modbus</a></li>
    <li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
  </ul>
</div>
</body>
</html>
